Interface VLANManager

All Superinterfaces:
IPCObject, Process
All Known Implementing Classes:
VLANManagerImpl

public interface VLANManager extends Process
Information provided by the PKI file:

    \class VlanManager
    
    \brief VlanManager holds and manipulates VLANs on routers and switches.
    
    \example network().getDevice("Switch0").getProcess("VlanManager")
    
Author:
Auto-generated
  • Method Details

    • getVlan

      VLAN getVlan(int vlanID)
      Information provided by the PKI file:
      
          \brief Returns the VLAN with the specified VLAN number.
          
          \param vlanID, the number of the VLAN of interest.
          
          \return Vlan, the Vlan object with the specified VLAN number.
          
              
      Parameters:
      vlanID - Takes in a parameter of vlanID
      Returns:
      VLAN Returns a VLAN
    • getVlanAt

      VLAN getVlanAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the VLAN at the specified index.
          
          \param index, the index of the VLAN of interest.
          
          \return Vlan, the Vlan object at the specified index.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      VLAN Returns a VLAN
    • addVlan

      boolean addVlan(int vlandID, String vlanName)
      Information provided by the PKI file:
      
          \brief Adds a VLAN.
          
          \param vlandID, the number for the VLAN.
          \param vlanName, the name for the VLAN.
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      vlandID - Takes in a parameter of vlandID
      vlanName - Takes in a parameter of vlanName
      Returns:
      boolean Returns a boolean
    • removeVlan

      boolean removeVlan(int vlandID)
      Information provided by the PKI file:
      
          \brief Removes the VLAN with the specified VLAN number.
          
          \param vlandID, the VLAN number of interest.
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      vlandID - Takes in a parameter of vlandID
      Returns:
      boolean Returns a boolean
    • getVlanCount

      int getVlanCount()
      Information provided by the PKI file:
      
          \brief Returns the number of VLANs.
          
          \return int, the number of VLANs.
          
              
      Returns:
      int Returns a int
    • getMaxVlans

      int getMaxVlans()
      Information provided by the PKI file:
      
          \brief Returns the maximum number of VLANs.
          
          \return int, the maximum number of VLANs.
          
              
      Returns:
      int Returns a int
    • getVlanByName

      VLAN getVlanByName(String name)
      Information provided by the PKI file:
      
          \brief Returns the VLAN with the specified VLAN name.
          
          \param name, the name of the VLAN of interest.
          
          \return Vlan, the Vlan object with the specified VLAN name.
          
              
      Parameters:
      name - Takes in a parameter of name
      Returns:
      VLAN Returns a VLAN
    • changeVlanName

      boolean changeVlanName(int vlanID, String name)
      Information provided by the PKI file:
      
          \brief Changes the VLAN name.
          
          \param vlanID, the VLAN number of interest.
          \param name, the name for the VLAN.
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      vlanID - Takes in a parameter of vlanID
      name - Takes in a parameter of name
      Returns:
      boolean Returns a boolean
    • addVlanInt

      boolean addVlanInt(int vlanID)
      Information provided by the PKI file:
      
          \brief Adds a VLAN interface with the specified VLAN number.
          
          \param vlanID, the VLAN number for the VLAN interface.
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      vlanID - Takes in a parameter of vlanID
      Returns:
      boolean Returns a boolean
    • removeVlanInt

      boolean removeVlanInt(int vlanID)
      Information provided by the PKI file:
      
          \brief Removes the VLAN interface with the specified VLAN number.
          
          \param vlanID, the VLAN number of interest.
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      vlanID - Takes in a parameter of vlanID
      Returns:
      boolean Returns a boolean
    • getVlanInt

      RouterPort getVlanInt(int vlanID)
      Information provided by the PKI file:
      
          \brief Returns the VLAN interface with the specified VLAN number.
          
          \param vlanID, the VLAN number of interest.
          
          \return RouterPort, the RouterPort object of the VLAN interface with the specified VLAN number.
          
              
      Parameters:
      vlanID - Takes in a parameter of vlanID
      Returns:
      RouterPort Returns a RouterPort
    • getVlanIntAt

      RouterPort getVlanIntAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the VLAN interface at the specified index.
          
          \param index, the index of the VLAN interface of interest.
          
          \return RouterPort, the RouterPort object of the VLAN interface at the specified index.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      RouterPort Returns a RouterPort
    • getVlanIntCount

      int getVlanIntCount()
      Information provided by the PKI file:
      
          \brief Returns the number of VLAN interfaces.
          
          \return int, the number of VLAN interfaces.
          
              
      Returns:
      int Returns a int